Skip to content

docs: CODEOWNERS review gate for docs/design + move drafts out#305

Merged
bkontur merged 14 commits into
devfrom
bko-codeowners-design
Jul 22, 2026
Merged

docs: CODEOWNERS review gate for docs/design + move drafts out#305
bkontur merged 14 commits into
devfrom
bko-codeowners-design

Conversation

@bkontur

@bkontur bkontur commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

What

Introduce a review gate for canonical design docs, reorganize docs/, and pull unratified / stale material out of the review-gated design.

1. CODEOWNERS review gate

Adds .github/CODEOWNERS requiring @eskimor's review for any change under docs/design/** (recursive — all files, all subdirs).

⚠️ The file alone is advisory. To enforce it, a repo admin must add a branch-protection rule / ruleset on dev (the default branch, which is where GitHub reads CODEOWNERS from):

  • Require a pull request before mergingRequire review from Code Owners
  • Do not allow bypassing the above settings
  • Confirm eskimor has Write access (otherwise the review won't count as code-owner approval).

2. Docs reorg

  • docs/design/ now holds only the two canonical, review-gated docs: scalable-web3-storage.md and scalable-web3-storage-implementation.md.
  • Moved the other unratified notes to a new docs/drafts/ (rename-tracked): CHECKPOINT_PROTOCOL, CLIENT_SIDE_ENCRYPTION, EXECUTION_FLOWS, marketplace, provider-initiated-checkpoints, S3_METADATA_INDEX, smart-contracts.
  • Fixed all cross-references (../design/… → ../drafts/…); no broken links remain.
  • Rewrote docs/README.md: added drafts/ to the tree, split Design (canonical) from Drafts (WIP, needing triage), and simplified.

3. Pulled unratified / stale material out of canonical design

Follow-up issues

Notes

  • Drafts are intentionally left outside the CODEOWNERS gate so they stay freely editable; each should be triaged — promoted into design/, folded into an existing doc, or dropped.

Comment thread docs/design/scalable-web3-storage-implementation.md Outdated
@bkontur
bkontur force-pushed the bko-codeowners-design branch 2 times, most recently from bbaa76e to 774d6eb Compare July 22, 2026 08:45
Move the Layer 1 (file-system & S3) interface design into
docs/drafts/L1_design_implementation.md, remove it from the Layer 0
implementation doc (including the provider-API endpoint group and the
auth reference), and flag it for triage against #51. Add a triage note
to the root README.
@bkontur
bkontur force-pushed the bko-codeowners-design branch from 774d6eb to b29db01 Compare July 22, 2026 08:59
bkontur added 3 commits July 22, 2026 11:14
Move the off-chain Provider-Initiated Checkpoint Coordination endpoint
section out of the review-gated Layer 0 implementation doc into
docs/drafts/provider-initiated-checkpoints.md (as the shipped API,
flagging drift from that draft's proposed API), drop the now-orphaned
provider-node endpoint group, and fix the group count.
… doc

Pull the entire provider-initiated checkpoint surface (config constants,
storage, events, signed payload, on-chain extrinsics) out of the
review-gated Layer 0 implementation doc, pending triage on whether the
feature is wanted at all (see follow-up issue). Client-initiated
checkpoint / extend_checkpoint / challenge_checkpoint are unchanged.
The removed content remains recoverable from git for a clean revert.

@eskimor eskimor left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving the rule + design changes. Only skimmed through the rest (looks also sensible).

@bkontur
bkontur merged commit 54d6f85 into dev Jul 22, 2026
33 checks passed
@bkontur
bkontur deleted the bko-codeowners-design branch July 22, 2026 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants